home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / sfantrv2.zip / SFANTRV2.DOC < prev    next >
Text File  |  1992-04-24  |  15KB  |  339 lines
  1.                                  
  2.                                SFANTRV2
  3.                               Version 2.0
  4.                                   by
  5.                              Lynda Kendrick
  6.                        Ganas The LABOR of LOVE BBS
  7.                                  In
  8.                              Alva, Florida
  9.     
  10.    INTRODUCTION
  11.    ------------
  12.                          
  13.       SFANTRV2 is a fast paced  Animal / Creature game designed to run
  14.    as a door feature within the SPITFIRE Bulletin Board System.  It can
  15.    also be installed as a sysop configurable command from the Main, File
  16.    or Message menus of SPITFIRE.  A data file containing over 600 PLUS
  17.    Trivia questions is randomly accessed and displayed to the screen.
  18.    With each question that is displayed, four multiple choice options 
  19.    are provided from which the player may select.  SFANTRV2 allows the
  20.    player ten seconds to read the question and respond with the number 
  21.    corresponding to the answer they wish to select.
  22.     
  23.    SFANTRV2 SETUP AS A SPITFIRE DOOR
  24.    ---------------------------------
  25.     
  26.       To set up SFANTRV2 to be executed as a door, it is recommended that
  27.    a separate directory be set up for it.  For explanation purposes, let's
  28.    assume the directory DOORA is created for use with SFANTRV2. The following
  29.    files must then be placed in the directory:
  30.    
  31.    SFANTRV2.EXE    The actual game program.
  32.    
  33.    SFANTRV2.DAT    The data file containing the trivia questions.
  34.    
  35.    SFANTRV2.TOP    This is a listing of the top ten players. SFANTRV2.EXE
  36.                    will create this file if it is not found. 
  37.    
  38.    The Sysop will then need to use a text editor to edit the SF.BAT file   
  39.    as illustrated below:
  40.    
  41.    :DOOR_A
  42.    COPY SFDOORS.DAT C:\SF\DOOR_A
  43.    SFANTRV2
  44.    ERASE SFDOORS.DAT
  45.    CD\SF
  46.    GOTO LOOP
  47.    :DOOR_B
  48.      
  49.    You will notice that the commands needed to execute SFANTRV2 are placed
  50.    between the :DOOR_A and GOTO LOOP command lines.  These are entered in
  51.    place of the existing REM Place Program Name Here.  The following will 
  52.    briefly explain each of the commands which were set up within SF.BAT to 
  53.    run SFANTRV2 as a SPITFIRE Door program:
  54.    
  55.       SFDOORS.DAT is created automatically by SPITFIRE when a user enters a
  56.    door.  It contains information about the user such as name and password.
  57.    SFANTRV2 requires access to the information within SFDOORS.DAT. Therefore,
  58.    before executing the program it must be copied to the directory in which
  59.    SFSNTRV2 is running.
  60.    
  61.       SFANTRV2 is the program name and executes the game program from within
  62.    the door program.
  63.    
  64.       Once the user has terminated the game play of SFANTRV2 the SF.BAT file
  65.    erases the SFDOORS.DAT file.
  66.    
  67.    SFANTRV2  SETUP AS A SYSOP CONFIGURABLE COMMAND
  68.    ----------------------------------------------
  69.  
  70.       SPITFIRE has a sysop configurable command for the Main, Message and
  71.    File menus.  The sysop configurable command is executed through a
  72.    batch file which corresponds to the menu it is being run from.  In
  73.    other words, SFMAIN.BAT runs the sysop configurable command from
  74.    the Main Menu, SFMESS.BAT runs the one from the Message Menu and
  75.    SFFILE.BAT the one from the File Menu.  The commands necessary
  76.    to execute SFANTRV2 can be set up in the batch file which corresponds
  77.    to the menu you wish to have SFANTRV2 run from.
  78.  
  79.       The first thing you will need to establish is which of these menus
  80.    you wish to use to run SFANTRV2.  For this purpose, let's assume that
  81.    it is going to be set up so it can be run from the Main Menu.  (It
  82.    should be noted the set up procedure is the same regardless of which
  83.    Menu you are running SFANTRV2 from.)
  84.  
  85.       Next, you will need to decide what you wish to name the command
  86.    option and establish what security level will be required for
  87.    users of your system to be able to access this option.  Once this
  88.    is determined you will need to modify the SFMAIN.MNU file using
  89.    your favorite text editor, as long as it saves in ASCII format.
  90.    (Refer to the SPITFIRE manual for further documentation on this
  91.    if needed.  It should also be noted that if SFANTRV2 were being
  92.    set up to run from the File Menu, you would need to modify the
  93.    SFFILE.MNU file and if it was being set up to be run from the
  94.    Message Menu you would need to modify the SFMSG.MNU file.)
  95.  
  96.       Examining the default SFMAIN.MNU file, you will notice the sysop
  97.    configurable command appears as:
  98.  
  99.         <K>............. Add Your Own,,1000,@
  100.  
  101.       This will need to be replaced with a Command Character that will
  102.    be used to select the option from the menu.  It is ASOLUTELY IMPERATIVE
  103.    that the Command Character must not duplicate an existing Command
  104.    Character for another menu option.  You will then need to include
  105.    a brief description of the Wildcat door program you are running, two
  106.    commas, the security level required to access this feature, and another
  107.    comma followed by the a @.  The @ must not be changed! (For more detailed
  108.    information on modifying your SFMAIN.MNU, SFMSG.MNU or SFFILE.MNU refer
  109.    to your SPITFIRE manual.)
  110.     
  111.        <K>.... Brief Program Description,,10,@
  112.  
  113.       Now you will need to modify the corresponding batch file, SFMAIN.BAT,
  114.    so that it can be executed from the Main Menu.  Do this using your
  115.    favorite text editor, as long as it saves in ASCII format.  (Again, it
  116.    should be noted that if SFANTRV2 were being set up to run from the File
  117.    Menu, you would need to modify the SFFILE.BAT file and if it was being
  118.    set up to be run from the Message Menu you would need to modify the
  119.    SFMESS.BAT file.)
  120.  
  121.       Place the SFANTRV2.EXE file in the directory you wish to run the
  122.    program from.  SFANTRV2 will create its own player score file,
  123.    SFANTRV2.TOP, if does not already exist.
  124.  
  125.       The commands set up in the SFMAIN.BAT file are very similar to
  126.    those used for executing the game through a door in the SF.BAT file.
  127.    For instance, if you were running SFANTRV2 from the main SPITFIRE
  128.    directory your SFMAIN.BAT file might look like this:
  129.  
  130.        ECHO OFF
  131.        BRK OFF
  132.        SFANTRV
  133.        BRK ON
  134.  
  135.       (BRK is not included in the SPITFIRE package because it is written
  136.    and copyrighted by Solid Systems, 1985, but can be downloaded from
  137.    The Mother Board BBS and Buffalo Creek's BBS as well as a number of 
  138.    other BBS systems.  BRK is not required to run SFANTRV2, however, it
  139.    is recommended since it will prevent a user using the CTRL BRK command 
  140.    to terminate the batch file, gaining access to your system at the 
  141.    DOS level.)
  142.  
  143.       If you wish to set SFANTRV2 up in a separate subdirectory from
  144.    SPITFIRE, for instance, a subdirectory named SFANTRV2, your batch
  145.    file might look like this.
  146.  
  147.        ECHO OFF
  148.        BRK OFF
  149.        COPY SFMAIN.DAT \SF\SFANTRV2
  150.        CD \SF\SFANTRV2
  151.        SFANTRV2
  152.        ERASE SFMAIN.DAT
  153.        CD \SF
  154.        BRK ON
  155.  
  156.       When SFANTRV2 is executed, from either the door with the SF.BAT file
  157.    or from the sysop configurable command through a menu with the
  158.    corresponding batch file, it will first look for the SFMAIN.DAT file,
  159.    then the SFMESS.DAT file, then the SFFILE.DAT file and lastly the
  160.    SFDOORS.DAT file.  It will look for each of these files until it finds
  161.    it and the commands required for its execution.  If none of these
  162.    files are found, SFANTRV2 will halt its execution.
  163.  
  164.    LOCAL PLAY OF SFANTRV2
  165.    ---------------------
  166.  
  167.       It should also be noted that a Sysop can play SFANTRV2 locally by
  168.    entering the following command at the DOS prompt:
  169.    
  170.    C:> SFANTRV2 /L
  171.  
  172.    DTE LOCK FEATURE
  173.    ----------------
  174.  
  175.      SFANTRV2 automatically detects if the DTE is locked at 19200 baud. If
  176.    SFANTRV2 detects that the DTE is locked, then SFANTRV2 opens the serial
  177.    port to the maximum baud rate of your system.  If SFANTRV2 does not
  178.    detect that the DTE is locked, then the serial port is opened to the
  179.    baud rate of the caller.
  180.    
  181.    SYSOP FEATURES
  182.    --------------
  183.    
  184.       This door program contains several features which give the sysop 
  185.    control over the door game play on their BBS system.  First, a status 
  186.    line is displayed on the BBS monitor that provides information in 
  187.    regard to the caller's name, baud rate of the caller and the security 
  188.    level of the caller.     
  189.    
  190.       A SFANTRV2.LMT file allows the sysop to establish a time limit for
  191.    door play according to the security level the caller has on the system.  
  192.    To modify the accompanying SFANTRV2.LMT file, use your favorite text
  193.    editor to represent the various security levels you have available on 
  194.    your system, a comma then the corresponding time you wish to allow for 
  195.    that particular security level in minutes.  For instance, it might look 
  196.    like this:
  197.    
  198.    10,15
  199.    25,20
  200.    50,25
  201.    999,30
  202.    
  203.    Each security level should begin a new line and you should have a
  204.    setting for each security level you have available on your system.
  205.    If you do not have a time limit set for a particular security 
  206.    SFANTRV2 will default to the level 10 security level setting.
  207.    
  208.       Pressing the Shift Key and the F1 key simultaneously will 
  209.    terminate game play of SFANTRV2 and return the caller back to the
  210.    BBS.  Pressing the Shift Key and the F9 key simultaneously will
  211.    terminate game play of SFANTRV2 and log the caller off of the BBS.
  212.    If the Shift Key and the F9 key are pressed together, logging the
  213.    caller off the BBS, SPITFIRE will recycle and return to the
  214.    SPITFIRE Ready For Caller Prompt.   
  215.  
  216.    SFANTRV2 EXECUTION
  217.    -----------------
  218.       
  219.    When first executed, SFANTRV2 will display a list of the Top Ten high
  220.    score players and the percentage of correct responses they acheived
  221.    while playing SFANTRV2. Initially, this will be a dummy listing with
  222.    ten lines that display:
  223.    
  224.       0%...............YOUR NAME COULD BE HERE
  225.       
  226.    However, as the game is played, this will fill with the name of the
  227.    players and their percentage ratings.  
  228.    
  229.    NOTE: At least twenty questions must be attempted before SFANTRV2 will
  230.          will figure the percentage rating for the player.
  231.          
  232.    To keep things interesting...the Sysop can erase the file which contains
  233.    the top ten listings SFANTRV2.TOP on a routine basis to give additional
  234.    players a chance to have their name added to the list.
  235.    
  236.    As the top ten list is displayed, at the bottom of the screen  is a
  237.    question which prompts the user whether they want to have ANSI Graphics
  238.    (y/n)? available to them during game play.  If the user responds with a
  239.    y (for yes) the game will display in color and if the user responds with
  240.    a n (for no) the game will display in monochrome.
  241.   
  242.    PLAYING SFANTRV2
  243.    -----------------
  244.   
  245.       Immediately after pressing any key (other than <Q> for Quit) from 
  246.    the Top Ten listing the game screen is displayed.  The screen will
  247.    look like the following:
  248.       
  249.    ------------------------------------------------------------------------
  250.    
  251.    ╔═══════════════════════════════════════════╗
  252.    ║   >>>   ANIMAL AND CREATURE TRIVIA  <<<   ║
  253.    ║                Version 2.0                ║
  254.    ║ ANIMAL/CREATURE TRIVIA Door for Spitfire! ║
  255.    ║ GANAS The Labor of Love BBS (813)728-2132 ║
  256.    ║ In Cooperation With Buffalo Creek Software║
  257.    ║   Copyright (C) by Lynda Kendrick 1992    ║
  258.    ║           UNREGISTERED VERSION!           ║
  259.    ╚═══════════════════════════════════════════╝   
  260.        
  261.    RIGHT: 0                        WRONG: 0
  262.     
  263.    QUESTION:
  264.    The Animal/Creature trivia question will be displayed
  265.    here.
  266.     
  267.    <1> Choice 1                        <2> Choice 2
  268.    <3> Choice 3                        <4> Choice 4
  269.     
  270.              Enter Answer: [ 1 2 3 4 <Q>uit]?
  271.                        
  272.    -----------------------------------------------------------------------
  273.    
  274.    The first randomly choosen trivia question is selected from the data
  275.    file and is displayed to the screen. 
  276.    
  277.       The player makes his selection by entering the corresponding number.
  278.    As the game progresses, SFANTRV2 will provide a running total of the
  279.    correct answers and also of the wrong answers the user has selected
  280.    during the game play.
  281.  
  282.    If the ten second timer should elapse before you respond, SFANTRV2
  283.    will count this as a wrong response and add an incorrect answer to 
  284.    the total WRONG answers obtained so far.
  285.  
  286.    EXITING PLAY
  287.    ------------
  288.    
  289.       When you are ready to exit the game, simply select press "Q" for
  290.    <Q>uit.  If you qualify as one of the top ten players to date, 
  291.    SFANTRV2 will congratulate you for becoming one of the top ten scorers
  292.    and add your name to the Top Ten listing.  You will once again see the 
  293.    Top Ten list displayed with your name added to the list.  
  294.    
  295.      If you exit the game before you have completed the twenty
  296.    questions required for eligibility to the Top Ten list or if you do not
  297.    qualify as a Top Ten player, the Top Ten listing will be displayed and 
  298.    you will be prompted to press any key to return to SPITFIRE.
  299.    
  300.    DISTRIBUTION
  301.    ------------
  302.      
  303.       Please feel free to share SFANTRV2.ZIP with others.  However, it must
  304.    be distributed with SFANTRV2.EXE, SFANTRV2.DAT, SFANTRV2.TOP and the
  305.    SFANTRV2.DOC in the SFANTRV2.ZIP distribution package.  These files must
  306.    not be altered in any way or by any means.
  307.    
  308.         SFANTRV2.ZIP is distributed as Shareware software.  You are free to
  309.    try SFANTRV2, and if you find it to be a program you use please send the
  310.    required $10.00 fee to:
  311.    
  312.                              Lynda  Kendrick
  313.                              P. O. Box 835
  314.                              Alva, Fl 33920
  315.                              
  316.    DISCLAIMER
  317.    ----------
  318.    
  319.      Lynda kendrick shall not be held responsible for any damage incurred
  320.    by the user to hardware, software, or peripheral devices while running
  321.    SFANTRV2.  All responsibility lies in the user of the software.
  322.    
  323.       Many thanks are indeed owed to Mike Woltz of Buffalo Creek BBS (515)-
  324.    225-8496 for his assistance.  Without his help this program would not
  325.    have been possible.  Also, Dia Spriggs of Pet Place BBS (305)624-2190,
  326.    Mike May of The Norwegian Fjord Horse Registry in Webster, N.Y.
  327.    Plus Jean Prophet and the rest of my friends & sysops of Fidonet/371.
  328.    But mainly my family = Mom,Sharon,Kim and Nikki plus Gizmo,Tommie,Sparky
  329.    and Miki and ALL the rest of the members of Ganas The LABOR of LOVE BBS!
  330.  
  331.    SFANTRV2 and other SPITFIRE programs are available for download from:
  332.    
  333.         Buffalo Creek BBS                   Ganas The LABOR of Love BBS
  334.         Sysop - Mike Woltz                       Lynda Kendrick
  335.           (515) 225-8496                         (813) 728-2132
  336.        19200/9600/2400/1200                         2400/1200
  337.  
  338.                ================ E O F ==================
  339.